API Documentation
DofComplexEffect.h
1 // DofComplexEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
16  class DofComplexEffect final : public ComplexEffect
17  {
18  public :
19 
32 
33  // Getters
37  virtual COMPLEX_EFFECT_TYPE getType () const override ;
60  float getNearPlaneDistance () const ;
64  float getFocalPlaneDistance () const ;
68  float getFarPlaneDistance () const ;
72  unsigned int getBlurStrength () const ;
76  bool getLinearDepth () const ;
77 
78  // Setters
113  void setNearPlaneDistance (float value) ;
123  void setFocalPlaneDistance (float value) ;
133  void setFarPlaneDistance (float value) ;
143  void setBlurStrength (unsigned int value) ;
154  void setLinearDepth (bool value) ;
155 
156  // Load
160  virtual bool load () override ;
164  virtual void unload () override ;
165  } ;
166 }
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition: ComplexEffectType.h:12
nkAstraeus::DofComplexEffect::setSourceDepth
void setSourceDepth(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::getBlurStrength
unsigned int getBlurStrength() const
nkGraphics::Camera
Offers all controls to model a camera.
Definition: Camera.h:12
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::DofComplexEffect::getSourceDepth
nkGraphics::Texture * getSourceDepth() const
nkAstraeus::DofComplexEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::DofComplexEffect::DofComplexEffect
DofComplexEffect(nkMemory::StringView name)
nkAstraeus::DofComplexEffect::getNearPlaneDistance
float getNearPlaneDistance() const
nkAstraeus::DofComplexEffect::getCamera
nkGraphics::Camera * getCamera() const
nkAstraeus::DofComplexEffect::setFarPlaneDistance
void setFarPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getLinearDepth
bool getLinearDepth() const
nkAstraeus::DofComplexEffect::setLinearDepth
void setLinearDepth(bool value)
nkAstraeus::DofComplexEffect::getOutputTexture
nkGraphics::Texture * getOutputTexture() const
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus::DofComplexEffect::setNearPlaneDistance
void setNearPlaneDistance(float value)
nkAstraeus::DofComplexEffect::setBlurStrength
void setBlurStrength(unsigned int value)
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: Engine.h:7
nkAstraeus::DofComplexEffect
A Depth of Field effect.
Definition: DofComplexEffect.h:17
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkAstraeus::DofComplexEffect::load
virtual bool load() override
nkAstraeus::DofComplexEffect::unload
virtual void unload() override
nkAstraeus::DofComplexEffect::getFarPlaneDistance
float getFarPlaneDistance() const
nkAstraeus::DofComplexEffect::setCamera
void setCamera(nkGraphics::Camera *value)
nkAstraeus::DofComplexEffect::setFocalPlaneDistance
void setFocalPlaneDistance(float value)
nkAstraeus::DofComplexEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::DofComplexEffect::getType
virtual COMPLEX_EFFECT_TYPE getType() const override
nkAstraeus::DofComplexEffect::getFocalPlaneDistance
float getFocalPlaneDistance() const
nkAstraeus::DofComplexEffect::~DofComplexEffect
~DofComplexEffect()